Skip to content

docs: config-management tools can roll back plugin registration - #41

Merged
zheng-weihao merged 1 commit into
orbcli:mainfrom
zheng-weihao:docs/config-manager-faq
Aug 15, 2026
Merged

docs: config-management tools can roll back plugin registration#41
zheng-weihao merged 1 commit into
orbcli:mainfrom
zheng-weihao:docs/config-manager-faq

Conversation

@zheng-weihao

Copy link
Copy Markdown
Member

What changed

  • USAGE §2 (Prerequisites) gains a Config-management tools subsection: provider switchers, dotfile syncers, and similar tools commonly snapshot the whole config file and restore it later, so anything written after the snapshot — including Orbit's plugin registration — is silently rolled back, while the on-disk content (marketplace snapshot, plugin cache) is never touched.
  • Recovery: re-run the installer (every install re-registers and refreshes). Prevention: keep Orbit's registration entries in the tool's stored config, with the exact per-host snippets: Codex config.toml tables, Claude enabledPlugins, and the OpenCode npm plugin array (the install.sh OpenCode path needs no config entry and is unaffected).
  • README install bullets link the new subsection.

Checklist

  • shellcheck orbit.sh install.sh passes (N/A — docs-only change)
  • bats tests/ passes (N/A — docs-only change)
  • New features include tests (N/A — no behavior change)
  • Documentation updated (if user-facing behavior changed)

- USAGE: new "Config-management tools" subsection in Prerequisites —
  snapshot-restore tools silently roll back post-snapshot writes, so
  Orbit's plugin registration can vanish while on-disk content
  (marketplace snapshot, plugin cache) survives
- Recovery: re-run the installer; prevention: keep Orbit's registration
  entries in the tool's stored config, with exact per-host snippets
  (Codex config.toml tables, Claude enabledPlugins, OpenCode npm array)
- README: link the new subsection from the install bullet list

Signed-off-by: Zheng Weihao <zheng-weihao@outlook.com>
@zheng-weihao
zheng-weihao merged commit feaf958 into orbcli:main Aug 15, 2026
2 checks passed
@zheng-weihao
zheng-weihao deleted the docs/config-manager-faq branch August 24, 2026 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant